Remove-GSGroupMember

SYNOPSIS

Removes members from a group

SYNTAX

Remove-GSGroupMember [-Identity] <String> [-Member] <String[]> [-WhatIf] [-Confirm] [<CommonParameters>]

DESCRIPTION

Removes members from a group

EXAMPLES

EXAMPLE 1

Remove-GSGroupMember -Identity admins -Member joe.smith,mark.taylor -Confirm:$false

Removes members Joe Smith and Mark Taylor from the group [email protected] and skips asking for confirmation

PARAMETERS

-Identity

The email or unique Id of the group to remove members from

Type: String
Parameter Sets: (All)
Aliases: GroupEmail, Group, Email

Required: True
Position: 1
Default value: None
Accept pipeline input: True (ByPropertyName, ByValue)
Accept wildcard characters: False

-Member

The member or array of members to remove from the target group

Type: String[]
Parameter Sets: (All)
Aliases: PrimaryEmail, UserKey, Mail, User, UserEmail, Members

Required: True
Position: 2
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-Confirm

Prompts you for confirmation before running the cmdlet.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: wi

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS

OUTPUTS

NOTES

Comments